Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using dotnet publish to find refs for docs #219

Merged
merged 14 commits into from
Oct 28, 2020
Merged

Conversation

TheAngryByrd
Copy link
Owner

@TheAngryByrd TheAngryByrd commented Oct 24, 2020

Proposed Changes

This speeds up doc generation considerably and more reliably by relying on dotnet publish rather than trying to convice FCS to give the reference.

Also updates:

Types of changes

What types of changes does your code introduce to MiniScaffold?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • Build and tests pass locally
  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added necessary documentation (if appropriate)

Further comments

This main reason for this change is speed and reliability. The code we had for FCS to pull out references to libraries could be slow on bigger projects. I think we were paying some more MSBuild costs than I wanted to and I don't know all the incantations to make FCS only do design time cracking. We also still have to build the project to get the DLL so this was extremely slow.

When using publish we pay the cost of building and references at the same time.

This speeds up doc generation considerably and more reliably by relying on dotnet publish rather than trying to convice FCS to give the reference
@TheAngryByrd TheAngryByrd merged commit a1f70d1 into master Oct 28, 2020
@TheAngryByrd TheAngryByrd deleted the speed-up-docs branch October 28, 2020 14:29
TheAngryByrd added a commit that referenced this pull request Nov 11, 2020
## [0.25.1] - 2020-11-11

### Fixed
- Performance improvement of documentation generation from [@TheAngryByrd](https://github.com/TheAngryByrd) - #219
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant